<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>Column Element (Eclipse BIRT ROM Documentation)</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<p class="title">Eclipse BIRT Report Object Model (ROM)</p>
<p class="subtitle">Column Element</p>
<h1>Element Overview</h1>
<div class="section-text">
Describes one column within a table or grid.</div>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Column</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>XML Element:</td>
<td><code>column</code></td></tr>
<tr><td>Extends:</td>
<td>None</td></tr>
<tr><td>Extendable:</td>
<td>No</td></tr>
<tr><td>Abstract:</td>
<td>No</td></tr>
<tr><td>Name Space:</td>
<td>None</td></tr>
<tr><td>Name Requirement:</td>
<td>Not Supported</td></tr>
<tr><td>Allows User Properties:</td>
<td>No</td></tr>
<tr><td>Has Style:</td>
<td>Yes</td></tr>
<tr><td>Default Style:</td>
<td>None</td></tr>
</table>

<h3>Property Summary</h3>

<dl class="section-text">
<dt><a href="#Property-repeat">repeat</a></dt>
<dd>The number of adjacent columns described by this element.</dd>
<dt><a href="#Property-style">style</a></dt>
<dd>Name of the style applied to this column.</dd>
<dt><a href="#Property-suppressDuplicates">suppressDuplicates</a></dt>
<dd></dd>
<dt><a href="#Property-viewAction">viewAction</a></dt>
<dd></dd>
<dt><a href="#Property-visibility">visibility</a></dt>
<dd></dd>
<dt><a href="#Property-width">width</a></dt>
<dd>The width of the column.</dd>
</dl>

<h3>Style Properties</h3>

<p class="section-text">
<a href="Style.html#Property-backgroundAttachment">backgroundAttachment</a>, 
<a href="Style.html#Property-backgroundColor">backgroundColor</a>, 
<a href="Style.html#Property-backgroundImage">backgroundImage</a>, 
<a href="Style.html#Property-backgroundPositionX">backgroundPositionX</a>, 
<a href="Style.html#Property-backgroundPositionY">backgroundPositionY</a>, 
<a href="Style.html#Property-backgroundRepeat">backgroundRepeat</a>, 
<a href="Style.html#Property-bidiTextDirection">bidiTextDirection</a>, 
<a href="Style.html#Property-canShrink">canShrink</a>, 
<a href="Style.html#Property-color">color</a>, 
<a href="Style.html#Property-dateTimeFormat">dateTimeFormat</a>, 
<a href="Style.html#Property-display">display</a>, 
<a href="Style.html#Property-fontFamily">fontFamily</a>, 
<a href="Style.html#Property-fontSize">fontSize</a>, 
<a href="Style.html#Property-fontStyle">fontStyle</a>, 
<a href="Style.html#Property-fontVariant">fontVariant</a>, 
<a href="Style.html#Property-fontWeight">fontWeight</a>, 
<a href="Style.html#Property-highlightRules">highlightRules</a>, 
<a href="Style.html#Property-letterSpacing">letterSpacing</a>, 
<a href="Style.html#Property-lineHeight">lineHeight</a>, 
<a href="Style.html#Property-mapRules">mapRules</a>, 
<a href="Style.html#Property-marginBottom">marginBottom</a>, 
<a href="Style.html#Property-marginLeft">marginLeft</a>, 
<a href="Style.html#Property-marginRight">marginRight</a>, 
<a href="Style.html#Property-marginTop">marginTop</a>, 
<a href="Style.html#Property-masterPage">masterPage</a>, 
<a href="Style.html#Property-numberAlign">numberAlign</a>, 
<a href="Style.html#Property-numberFormat">numberFormat</a>, 
<a href="Style.html#Property-orphans">orphans</a>, 
<a href="Style.html#Property-paddingBottom">paddingBottom</a>, 
<a href="Style.html#Property-paddingLeft">paddingLeft</a>, 
<a href="Style.html#Property-paddingRight">paddingRight</a>, 
<a href="Style.html#Property-paddingTop">paddingTop</a>, 
<a href="Style.html#Property-pageBreakAfter">pageBreakAfter</a>, 
<a href="Style.html#Property-pageBreakBefore">pageBreakBefore</a>, 
<a href="Style.html#Property-showIfBlank">showIfBlank</a>, 
<a href="Style.html#Property-stringFormat">stringFormat</a>, 
<a href="Style.html#Property-textAlign">textAlign</a>, 
<a href="Style.html#Property-textIndent">textIndent</a>, 
<a href="Style.html#Property-textLineThrough">textLineThrough</a>, 
<a href="Style.html#Property-textOverline">textOverline</a>, 
<a href="Style.html#Property-textTransform">textTransform</a>, 
<a href="Style.html#Property-textUnderline">textUnderline</a>, 
<a href="Style.html#Property-verticalAlign">verticalAlign</a>, 
<a href="Style.html#Property-whiteSpace">whiteSpace</a>, 
<a href="Style.html#Property-widows">widows</a>, 
<a href="Style.html#Property-wordSpacing">wordSpacing</a>
</p>
<h3>Description</h3>

<div class="section-text">
<p>The column element defines one column within a grid. If 
an element references a column that does not exist, then BIRT creates the column 
implicitly as a variable-width column.</p>
<p>The developer defines columns to aid in report layout. 
Each column has the following properties:</p>

<ul>
<li>Width: a column can be variable width or fixed width.</li>

<li>Style: a column can use the style defined for the grid as a whole, or can define a separate style. The developer uses this to create a distinct border around the column, use a different background color, etc.</li>

<li>Alignment: how to align items with the column: left, center or right.</li>

</ul>
<p>Each column definition element defines one or more 
adjacent columns in the table. The column definition section is optional. If not 
provided, BIRT ERD computes the set of columns from the table bands, as 
described below.</p></div>
<h1>Property Detail</h1>

<h2><a name="Property-repeat">repeat Property</a></h2>

<p class="section-text">The number of adjacent columns described by this element.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#integer">integer</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Repeat</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>1</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p><p>A table often has a series of columns with an identical 
format. For example, an accounting report may display debits in one column and 
credits in another. This property is a convenience to allow defining the column 
attributes once, and apply them to a set of adjacent columns.</p></p></div>

<hr>
<h2><a name="Property-style">style Property</a></h2>

<p class="section-text">Name of the style applied to this column.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../elements/Style.html">Style</a> Reference</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Style</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p><p>Column provides many style properties. The style 
properties are defined in the <i>ROM Styles Specification</i>. A column can 
inherit its style properties from a parent element, from a named style, or from 
a style that identifies the context in which the item appears. This property 
provides the name of the shared style to use.</p>
<p>This item can also set the value of style properties. 
Properties set on this element &quot;override&quot; those inherited from a parent element 
or a shared style.</p></p></div>
<h3>See Also</h3>

<div class="section-text">
<p>Style element in the <i>ROM Styles Specification</i>.</p></div>

<hr>
<h2><a name="Property-suppressDuplicates">suppressDuplicates Property</a></h2>

<p class="section-text"></p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#boolean">boolean</a></td></tr>
<tr><td>Since:</td>
<td>2.1</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Suppress duplicates</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>false</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>


<hr>
<h2><a name="Property-viewAction">viewAction Property</a></h2>

<p class="section-text"></p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#choice">choice</a> (viewAction)</td></tr>
<tr><td>Since:</td>
<td>2.1</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>View action</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>NoChange</td></tr>
<tr><td>Inherited:</td>
<td>No</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Choices</h3>

<table class="section-table">
<thead><tr><td>Name</td><td>Display Name</td>
<td>Value</td><td>Description</td></tr></thead>
<tbody>
<tr><td>NoChange</td>
<td>No Change</td>
<td>NoChange</td>
<td></td></tr>
<tr><td>Changed</td>
<td>Changed</td>
<td>Changed</td>
<td></td></tr>
<tr><td>Added</td>
<td>Added</td>
<td>Added</td>
<td></td></tr>
<tr><td>Deleted</td>
<td>Deleted</td>
<td>Deleted</td>
<td></td></tr>
</tbody></table><br>

<hr>
<h2><a name="Property-visibility">visibility Property</a></h2>

<p class="section-text"></p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td>List of <a href="../structs/HideRule.html">HideRule</a> Structures</td></tr>
<tr><td>Since:</td>
<td>2.1</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Visibility</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>


<hr>
<h2><a name="Property-width">width Property</a></h2>

<p class="section-text">The width of the column.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#dimension">dimension</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Width</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p><p>The width of the column. The width can be omitted. If so, 
BIRT  automatically computes the width based on the content of the table.</p>
<p>Widths can be absolute (1 inch) or relative (20%). Widths 
are entered using the CSS dimension system. See the discussion of Dimensions in 
the <i>ROM Overview Specification</i> for details.</p>
<p></p></p></div>
</body>
</html>
